<html><head>
      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   <title>Chapter&nbsp;4.&nbsp;Tools</title><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e1"></a>Chapter&nbsp;4.&nbsp;Tools</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#d0e4">Indexing</a></span></dt><dt><span class="section"><a href="#d0e11">Searching</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e4"></a>Indexing</h2></div></div></div><p>
			The Semantic Indexer can be used to index a collection of documents and then 
			store them in a database (storage) engine.
		</p><pre class="screen">
Usage: semantic_indexer [options] &lt;directory to index&gt;

Options: 
  --help                                   Produce this help message
 
  --version                                Print version information
  
  -v [ --verbose ]                         Verbose output
  
  -c [ --collection ] arg (=My Collection) The name of the collection to index
  
  -e [ --encoding ] arg (=iso-8859-1)      Set the default encoding

  --term_type arg (=nouns)                 Set the term type to be extracted

  --document_minimum arg (=1)              Set the minimum number of times a
                                           term must appear in a document to
                                           be included in the index

  --collection_minimum arg (=3)            Set the minimum number of times a
                                           term must appear across the
                                           collection to be included in the
                                           index
  
  --collection_maximum arg (=0.2)          Set the maximum document-frequency
                                           (between 0 and 1) for a term to be
                                           included in the index
  
  --disable_stemmer                        Turn off the stemming of terms
  
  -f [ --file ] arg                        Write the term index data to a file
  
  -s [ --sqlite ] arg                      The SQLite 3 database file to use.
                                           the file will be created if needed
  
  -m [ --mysql ] arg                       The MySQL database name
  -u [ --mysql_username ] arg (=aaron)     The MySQL database username
  -p [ --mysql_password ] arg              The MySQL database password
  -h [ --mysql_hostname ] arg (=localhost) The MySQL database host
</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e11"></a>Searching</h2></div></div></div><p>
            Once a collection of documents is indexed, the Semantic Search tool can be used to query 
			the collection. Automatic clustering and summarization of the search results are also 
			available.
        </p><pre class="screen">
Usage: semantic_search [options] "query"

Options: 
  --help                                   produce this help message

  --version                                print version information

  -c [ --collection ] arg (=My Collection) The collection to search

  --summaries                              Print summaries for each document

  --spread arg (=0.3)                      a value from 0 to 1, specifying how
                                           broad the search. 1 = most broad

  --cluster                                output results in clusters instead
                                           of a list

  --num_clusters arg (=4)                  the number of clusters

  -s [ --sqlite ] arg                      the SQLite 3 database file to use

  -m [ --mysql ] arg                       the MySQL database name
  -u [ --mysql_username ] arg (=aaron)     the MySQL database username
  -p [ --mysql_password ] arg              the MySQL database password
  -h [ --mysql_hostname ] arg (=localhost) the MySQL database host
</pre></div></div></body></html>